DealsApi
All URIs are relative to //api.estuary.tech/
| Method | HTTP request | Description |
|---|---|---|
| DealEstimatePost | Post /deal/estimate | Estimate the cost of a deal |
| DealInfoDealidGet | Get /deal/info/{dealid} | Get Deal Info |
| DealProposalPropcidGet | Get /deal/proposal/{propcid} | Get Proposal |
| DealQueryMinerGet | Get /deal/query/{miner} | Query Ask |
| DealStatusByProposalPropcidGet | Get /deal/status-by-proposal/{propcid} | Get Deal Status by PropCid |
| DealStatusMinerPropcidGet | Get /deal/status/{miner}/{propcid} | Deal Status |
| DealTransferInProgressGet | Get /deal/transfer/in-progress | Transfer In Progress |
| DealTransferStatusPost | Post /deal/transfer/status | Transfer Status |
| DealsFailuresGet | Get /deals/failures | Get storage failures for user |
| DealsMakeMinerPost | Post /deals/make/{miner} | Make Deal |
| DealsStatusDealGet | Get /deals/status/{deal} | Get Deal Status |
| PublicDealsFailuresGet | Get /public/deals/failures | Get storage failures |
| PublicMinersStorageQueryMinerGet | Get /public/miners/storage/query/{miner} | Query Ask |
DealEstimatePost
string DealEstimatePost(ctx, body) Estimate the cost of a deal
This endpoint estimates the cost of a deal
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | ApiEstimateDealBody | The size of the deal in bytes, the replication factor, and the duration of the deal in blocks |
Return type
string
Authorization
HTTP request headers
- Content-Type: /
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DealInfoDealidGet
string DealInfoDealidGet(ctx, dealid) Get Deal Info
This endpoint returns the deal info for a deal
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| dealid | int32 | Deal ID |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DealProposalPropcidGet
string DealProposalPropcidGet(ctx, propcid) Get Proposal
This endpoint returns the proposal for a deal
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| propcid | string | Proposal CID |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DealQueryMinerGet
string DealQueryMinerGet(ctx, miner) Query Ask
This endpoint returns the ask for a given CID
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| miner | string | CID |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DealStatusByProposalPropcidGet
string DealStatusByProposalPropcidGet(ctx, propcid) Get Deal Status by PropCid
Get Deal Status by PropCid
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| propcid | string | PropCid |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DealStatusMinerPropcidGet
string DealStatusMinerPropcidGet(ctx, miner, propcid) Deal Status
This endpoint returns the status of a deal
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| miner | string | Miner | |
| propcid | string | Proposal CID |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DealTransferInProgressGet
string DealTransferInProgressGet(ctx, ) Transfer In Progress
This endpoint returns the in-progress transfers
Required Parameters
This endpoint does not need any parameter.
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DealTransferStatusPost
string DealTransferStatusPost(ctx, body) Transfer Status
This endpoint returns the status of a transfer
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | ApiChannelIdParam | Channel ID |
Return type
string
Authorization
HTTP request headers
- Content-Type: /
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DealsFailuresGet
string DealsFailuresGet(ctx, ) Get storage failures for user
This endpoint returns a list of storage failures for user
Required Parameters
This endpoint does not need any parameter.
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DealsMakeMinerPost
string DealsMakeMinerPost(ctx, body, miner) Make Deal
This endpoint makes a deal for a given content and miner
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | string | Deal Request | |
| miner | string | Miner |
Return type
string
Authorization
HTTP request headers
- Content-Type: /
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DealsStatusDealGet
string DealsStatusDealGet(ctx, deal) Get Deal Status
This endpoint returns the status of a deal
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| deal | int32 | Deal ID |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PublicDealsFailuresGet
string PublicDealsFailuresGet(ctx, ) Get storage failures
This endpoint returns a list of storage failures
Required Parameters
This endpoint does not need any parameter.
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PublicMinersStorageQueryMinerGet
string PublicMinersStorageQueryMinerGet(ctx, miner) Query Ask
This endpoint returns the ask for a given CID
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| miner | string | CID |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]